home *** CD-ROM | disk | FTP | other *** search
/ JCSM Shareware Collection 1993 November / JCSM Shareware Collection - 1993-11.iso / cl040 / aswpac14.lzh / ASWPACK.DOC < prev    next >
Text File  |  1993-06-30  |  15KB  |  364 lines
  1.  
  2.  
  3.              AswPack 1.40 - Questionnaire Answer File Pack Utility
  4.                    Copyright (c) 1991-93 Serious Cybernetics
  5.                       by C. Scott Davis and Danny Sosebee
  6.  
  7.  
  8. -------------------------------------------------------------------------------
  9.  
  10.  
  11. The following files should be contained in ASWPAC14.ZIP :
  12.  
  13. ASWPACK.EXE       AswPack Programme
  14. ASWPACK.INI       AswPack Init/Config File
  15. RESOURCE.APF      AswPack Font Resource File (optional)
  16. RESOURCE.APV      AswPack Voice Resource File (optional)
  17. ASWPACK.DOC       AswPack documentation (this file)
  18. REGISTER.DOC      Registration information for AswPack
  19. REGISTER.FRM      Registration form for AswPack
  20. APREG.EXE         Programme to Register AswPack
  21. APTEST.EXE        Programme to test ASWPACK.INI and Resource file(s)
  22.  
  23.  
  24. -------------------------------------------------------------------------------
  25.  
  26.  
  27.  
  28. * Introduction
  29.  
  30. AswPack is one of those obvious little utilities for BBS sysops that everyone 
  31. seems to need but no one knows where do find it.  Since we couldn't find it 
  32. either, we decided to write one.  The end result is AswPack.
  33.  
  34.  
  35. * Just what is AswPack?
  36.  
  37. AswPack is a utility for sysops of QuickBBS(tm), ProBoard(tm) and compatible 
  38. BBS software.  It was designed to clean up duplicates in the .ASW Questionnaire 
  39. Answer Files produced when you execute a Q-A file from the BBS that saves it's 
  40. information to a file.  These answer files are pure text, and may contain a 
  41. wide variety of information.  One problem with this method of using a text file 
  42. to store the user responses is the inability of the BBS program to delete old 
  43. user information.  If you have your BBS set up to purge inactive users after a 
  44. set period, or if you allow users to re-answer a questionnaire (to update their 
  45. answers), then you will soon find there are duplicates in the answer file, as 
  46. well as records for users who no longer exist.  AswPack was created to repair 
  47. this problem IF IT IS USED CORRECTLY.
  48.  
  49.  
  50. * What do I need to run AswPack?
  51.  
  52. Many sysops have a NEWUSER.Q-A file containing a new user questionnaire.  If the 
  53. Q-A file creates an answer file, the filename will be NEWUSER.ASW (named by the 
  54. BBS itself).  Some sysops even have multiple questionnaires generating several 
  55. different answer files.  AswPack can be used on any or all of these answer 
  56. files.
  57.  
  58. Since the structure of the answer file is dependant on the way the sysop 
  59. designed the Q-A file which produces it, there is only one sure way of 
  60. detecting where the start of a user's answers are.  The line of text produced 
  61. by the questionnaire "POSTINFO" command will always contain specific 
  62. information based on the BBS software used.  AswPack makes use of this line as 
  63. a "header" record, as well as using it's date and time information to eliminate 
  64. duplicates.  Therefore, for AswPack to properly process your .ASW files, you 
  65. must have your questionaire use the POSTINFO command as the first command that 
  66. writes to the answer file.  AswPack will assume that all lines between two 
  67. header's belong to the first header, and will write the updated .ASW file 
  68. accordingly.
  69.  
  70. AswPack is also capable of processing "mixed" files (those containing both 
  71. QuickBBS[tm] and ProBoard[tm] formats).
  72.  
  73.  
  74. * How do I use AswPack?
  75.  
  76. Once you have determined that AswPack can process your answer files, the actual 
  77. installation and operation is quite simple.  Although you may run AswPack 
  78. manually from the DOS command prompt, AswPack is ideally suited for batch file 
  79. operation.  It is suggested that your AswPack instructions be placed in your 
  80. nightly maintanence update batch file, usually after the instructions to purge 
  81. old inactive users from your user file.
  82.  
  83. Note: Unregistered versions of AswPack will display a message and wait for
  84.       a key press before processing.
  85.  
  86. The command format for AswPack is as follows :
  87.  
  88.   ASWPACK [-[!]options] [d:][path]filename[.ext]
  89.  
  90.   Valid options are :
  91.  
  92.        !   reverses options
  93.       -n   No-windows mode
  94.       -m   Mono mode
  95.       -d   Dim mode
  96.       -p   Pop-up mode
  97.       -g   "Genius"-66 mode
  98.       -c#  Character set (0 to 2)
  99.       -q   Quiet mode
  100.       -i   Internal speaker mode
  101.       -k   Kill-backups mode
  102.       -u   User-search mode
  103.       -f#  output Format (0 to 2)
  104.       -l#  Log level (0 to 3)
  105.       -r   Restart log file
  106.  
  107. Options specified on the command line will override their counterparts in the 
  108. ASWPACK.INI file (see ASWPACK.INI for example settings).
  109.  
  110. AswPack's various options may be used in any combination or order. Although the 
  111. format specifies a "-" to preceed the options, a "/" can also be used.  Also, 
  112. options may be specified at any point on the command line, as long as each 
  113. group of options are preceeded by a "-" or a "/".  If "!" appears within a 
  114. group of options, all remaining options in that group will be turned "off" 
  115. instead of "on".  Each option is detailed next.
  116.  
  117. -n   No-windows mode :
  118.  
  119. (ASWPACK.INI setting "WINDOW=NONE")
  120.  
  121. If you want a straight text display (no windows), then you should specify
  122. the "N" parameter.
  123.  
  124. -m   Mono mode :
  125.  
  126. (ASWPACK.INI setting "DISPLAY=MONO")
  127.  
  128. Normally AswPack will detect your video state and automatically select 
  129. Monochrome or Colour modes.  However, this option may be used to override the 
  130. automatic detection in special cases (such as a colour card with a "black and 
  131. white" monitor).  This option has no effect if "N" is specified.
  132.  
  133. -d   Dim mode :
  134.  
  135. (ASWPACK.INI setting "DISPLAY=DIM")
  136.  
  137. The Dim mode option is useful for those who prefer a muted (dark) background 
  138. instead of a full colour display.  This option has no effect if "N" is 
  139. specified.
  140.  
  141.  
  142. -p   Pop-up mode :
  143.  
  144. (ASWPACK.INI setting "WINDOW=POPUP")
  145.  
  146. AswPack normally defaults to exploding window mode.  However, some people find 
  147. this irritating, and it can be very slow on slower PC's.  Therefore, you may 
  148. use the "P" option to force the faster "popup" window mode.  This option has no 
  149. effect if "N" is specified.
  150.  
  151.  
  152. -g   "Genius"-66 mode :
  153.  
  154. (ASWPACK.INI setting "GENIUS66=YES")
  155.  
  156. AswPack can normally detect your video hardware and adjust for whatever video 
  157. mode you are currently in.  However, some special "Page Displays" (for 
  158. instance, the "Genius" 66 line display) cannot be detected by AswPack.  If you 
  159. have one of these special displays, you may need to specify the "G" parameter 
  160. here.  This option has no effect if "N" is specified.
  161.  
  162.  
  163. -c   Character font (0 to 2) :
  164.  
  165. (ASWPACK.INI settings "FONT=NONE", "FONT=SYSTEM", "FONT=DEFINED")
  166.  
  167. If you have an EGA/VGA display adapter, AswPack will default to 2 (defined 
  168. font).  If you set this to 1, AswPack will use the current system font.  If you 
  169. set this to 0 (or no EGA/VGA is detected or the ASWPACK.APF file is missing or 
  170. corrupt), AswPack will attempt no font redefinitions.  This option has no 
  171. effect if "N" is specified. 
  172.  
  173. -q   Quiet mode :
  174.  
  175. (ASWPACK.INI setting "SOUND=NONE")
  176.  
  177. AswPack normally defaults to sound effects mode, but some may find the various 
  178. sounds irritating, or you may wish to run AswPack automatically at night 
  179. without it waking you up.  Specifying Quiet mode will nullify all sound 
  180. effects.
  181.  
  182. -i   Internal speaker mode :
  183.  
  184. (ASWPACK.INI setting "SOUND=INTERNAL")
  185.  
  186. By default, AswPack will attempt to send sound effects through a 
  187. SoundBlaster[tm] (or compatible) sound card.  If no such card is present or the 
  188. RESOURCE.APV file is missing or corrupt, AswPack will use the PC's internal 
  189. speaker.  Specifying Internal speaker mode will force AswPack to use the 
  190. internal speaker even if a sound card is available.
  191.  
  192. -k   Kill-backups mode :
  193.  
  194. (ASWPACK.INI setting "BACKUPS=NO")
  195.  
  196. AswPack normally defaults to backup-save mode, creating a backup of your answer 
  197. file with the same filename but with the extension .BAK.  However, you may 
  198. specify the "K" parameter to force AswPack to kill the backup file.  USE WITH 
  199. CAUTION!  TEST AswPack ON YOUR FILES WITHOUT THIS FIRST!
  200.  
  201. -u   User-search mode :
  202.  
  203. (ASWPACK.INI setting "USERS=@[d:][\path\]userfile")
  204.  
  205. AswPack normally defaults to ignore-user-file mode, processing only the answer 
  206. file.  However, you can optionally specify the "U" parameter to cause AswPack 
  207. to read the USERS.BBS file also.  When you do this, AswPack will delete answers 
  208. from any person who is NOT currently in the answer file, along with it's normal 
  209. dupe-elimination process.  This also takes an extra "pass" through the files.
  210.  
  211. -f#  output Format (0 to 2) :
  212.  
  213. (ASWPACK.INI settings "FORMAT=SAME", "FORMAT=QUICKBBS", "FORMAT=PROBOARD")
  214.  
  215. AswPack normally defaults to 0, meaning that the answer file is written in the 
  216. same format that it was read.  However, you may wish to force AswPack to write 
  217. in QuickBBS(tm) or ProBoard(tm) format.  If you set this to 1, AswPack will 
  218. write the answer file using QuickBBS(tm) format.  If you set this to 2, AswPack 
  219. will write the answer file using ProBoard(tm) format.
  220.  
  221. -l#  Log level (0 to 3) :
  222.  
  223. (ASWPACK.INI settings "LOG=NONE", "LOG=SUMMARY", "LOG=DETAIL")
  224.  
  225. AswPack normally defaults to 0, meaning No Log.  However, you may wish AswPack 
  226. to produce a log of it's activity.  If you set this to 1, 2, or 3, AswPack will 
  227. create ASWPACK.LOG containing a log of it's activity.  The higher the number, 
  228. the more information will be contained in the log.  In version 1.40, log level 
  229. 2 and 3 both produce the maximum detailed log.  Log level 2 is included for use 
  230. by future versions of AswPack.
  231.  
  232. -r   Restart log file :
  233.  
  234. (ASWPACK.INI setting "RESTART=YES")
  235.  
  236. AswPack normally defaults to append mode on it's log files.  However, this may 
  237. make your log files grow quite large unless you periodically delete them. If 
  238. you specify the "R" option here, AswPack will delete old logs before it creates 
  239. a new one.  If logging is disabled with the "L0" option, these settings have no 
  240. effect.
  241.  
  242. [d:][\path\] (default=current directory) :
  243.  
  244. The drive and path parameters may be optionally used to specify the location of 
  245. all of the data files you wish AswPack to use.  If you specify either of these 
  246. parameters, AswPack will look in the specified drive/directory for all of it's 
  247. input files (text file and user file), and will write it's output files to the 
  248. specified drive/directory.  If you do not specify either of these, AswPack will 
  249. default to the current drive/directory.
  250.  
  251. filename (required)
  252.  
  253. This is the only command line parameter that is required.  It should be the 
  254. name of the text file you wish AswPack to process.  The default extension is 
  255. .ASW, so it need not be specified.  Note that this is NOT the user file, which 
  256. is called USERS.BBS, but the name of the answer file (i.e. NEWUSER).
  257.  
  258. [.ext] (default=.ASW)
  259.  
  260. This is the optional filename extension.  Normally AswPack defaults to .ASW 
  261. because that's what the QuickBBS software names the file.  However, for those 
  262. sysops who rename their files, we have allowed full flexability in selecting 
  263. the input file.
  264.  
  265.      An example of how to use AswPack would be:
  266.  
  267. ASWPACK -DKL1 NEWUSER
  268.  
  269. This would cause AswPack to use Dim colour mode, Kill backups, use Log Level 1 
  270. (minimum information).  It would then process the file NEWUSER.ASW (in the 
  271. current directory).
  272.  
  273. "ASWPACK *" will display the current version and release date for AswPack.
  274.  
  275.  
  276. * AswPack Runtime Display
  277.  
  278. When AswPack executes, it display's a three level window.  The background 
  279. window displays the program and copyright information.  The next window shows a 
  280. scrolling display of detailed information on the file(s) being processed.  The 
  281. center status window shows what AswPack is currently doing, which pass it is 
  282. in, and a status graph of percentage complete.  Once AswPack completes, it 
  283. restores the screen to it's original state and displays the execution time and 
  284. number of records deleted.  Note that, if you have specified the "U" option, 
  285. AswPack will first read USERS.BBS, causing it to make one extra pass. If 
  286. AswPack encounters any errors, it will abort with a non-zero errorlevel, 
  287. display an error message and append an "error" entry to the ASWPACK.ERR error 
  288. file.  Note also that if you have specified the "N" option, no windows will
  289. be displayed.
  290.  
  291.  
  292. * More About RESOURCE.AP? files
  293.  
  294. AswPack can optionally use 2 resource files (RESOURCE.APF and RESOURCE.APV). 
  295. The APF file contains font redefinition information for EGA/VGA display and the 
  296. APV file contains digital voice samples for SoundBlaster(tm) and compatible 
  297. audio cards.  If you don't wish to use either (or both) of these features,
  298. you may safely delete the resource file(s).
  299.  
  300.  
  301. * More About Sound
  302.  
  303. AswPack will read the SOUND environment variable to determine where the 
  304. SoundBlaster(tm) files are located.  It expects to find the CT-VOICE.DRV file 
  305. in the DRV\ directory within the directory specified by SOUND.
  306.  
  307. For example, if your SoundBlaster(tm) files are located in a directory called 
  308. C:\SB, then you should have
  309.  
  310. SOUND=C:\SB
  311.  
  312. set and C:\SB\DRV should contain the SoundBlaster(tm) driver files (including 
  313. CT-VOICE.DRV).
  314.  
  315.  
  316. * AswPack Support
  317.  
  318. The latest version of AswPack can always be downloaded from our primary support 
  319. BBS below.  FidoNet file requests for magic filename "ASWPACK" will also obtain 
  320. the latest version.  Also request "FILES" for a nightly updated master file 
  321. listing, including several other utilities from Serious Cybernetics.
  322.  
  323. Primary Support BBS :
  324.  
  325.                  P h o e n i x   S t a r F i g h t e r   B B S
  326.             The home of "Serious Cybernetics"  -  FidoNet 1:3616/20
  327.            (404) 869-3410  -  Lula, Georgia, USA  -  24 Hour Service
  328.       Supporting 300/1200/2400/HST/v32/v32b/v42/v42b via USR HST/DS Modem
  329.                      Sysops:  Danny Sosebee and Scott Davis
  330.                      All Users Welcome!   Immediate Access!
  331.  
  332. AswPack is shareware.  You may copy and distribute ASWPAC14.ZIP freely. All I 
  333. ask is that you include all of the original files, unmodified.
  334.  
  335. If you like AswPack and use it, a registration fee of $10 is expected (see 
  336. REGISTER.DOC for more information).  This will also help to encourage future 
  337. enhancements to this utility and the writing of others like it. Comments, 
  338. questions, and suggestions are always welcome.  You may contact us via the BBS 
  339. listed above or at the following address:
  340.  
  341.            Serious Cybernetics
  342.            6804 Belton Place
  343.            Lula, GA  30554-2622  USA
  344.  
  345.  
  346. * Credits
  347.  
  348. AswPack was written in Borland Pascal (tm) 7.0, using Object Professional (tm) 
  349. 1.11 from Turbo Power; RkPlus (tm) 3.1, CmdParse 1.02 and ReSource 1.0 from 
  350. Serious Cybernetics.
  351.  
  352. Special thanks to Danny Sosebee and Ed Ivey for beta testing and suggestions.
  353.  
  354.  
  355. AswPack, RkPlus (c) 1991-93 Serious Cybernetics
  356. CmdParse (c) 1992-93 Serious Cybernetics
  357. ReSource (c) 1993 Serious Cybernetics
  358. Borland Pascal (c) 1983-92 Borland International
  359. Object Professional (c) 1989 TurboPower Software
  360. SoundBlaster (c) Creative Labs
  361. Stony Brook Pascal+ (c) 1987-93 Stony Brook Software
  362.  
  363.  
  364.